Navigation Tree

The /api/v1 URL displays the complete navigation tree that is supported by the REST API. This tree is displayed below:

/api/v1
       /actions
          /reset             // reset the device
          /saveConfiguration    // save configuration to NVRAM
          /authToken             // get authentication token
       /files                // files upload/download
          /amd                // Answer Machine Detection file
          /casTable            // CAS table
          /cliScript            // CLI script
          /configurationPackage    // Configuration Package file
          /cpt                // Call Progress Tones file
          /debugFile            // Debug file
          /debugFileRedundant    // Debug file for Redundant unit
          /dialplan            // Dial Plan file
          /ini                // INI configuration file
             /incremental        // Incremental INI file
          /prt                // Pre-Recorded Tone file
          /sbcWizard            // SBC Wizard template file
          /software            // CMP software file
          /tls/<id>            // TLS Context file
             /privateKey        // private key
             /certificate        // device certificate
                /request        // certificate signing request
             /trustedRoot        // trusted root
          /...                // other (auxiliary) files
       /alarms
          /active            // active alarms
          /history            // history alarms
       /license                // license management
       /kpi                // performance monitoring
          /current            // current PMs
          /history            // history PMs
          /interval            // interval of history PM
       /status                // device status
       /sip/sipRecording            // starts SIPREC sessions
       /sipTestCall
          /drop            // ends test call
          /getStatus            // displays test call results
          /dial           // starts test call
          /show           // displays test call configuration

URL

/api/v1

HTTP Method

GET

HTTP Response

200 OK

Example

GET /api/v1 HTTP/1.1
Host: 10.4.219.229
 
 
HTTP/1.1 200 OK
Content-Type: application/json
{
    "items": [
        {
            "id": "actions",
            "description": "Device actions",
            "url": "/api/v1/actions"
        },
        {
            "id": "alarms",
            "description": "Device alarms",
            "url": "/api/v1/actions"
        },
        {
            "id": "files",
            "description": "Upload and download of configuration files",
            "url": "/api/v1/files"
        },
        {
            "id": "license",
            "description": "License management",
            "url": "/api/v1/license"
        },
        {
            "id": "status",
            "description": "Device status",
            "url": "/api/v1/status"
        },
        {
            "id": "kpi",
            "description": "key indicators performance",
            "url": "/api/v1/kpi"
        }
    ]
}